package hirt;

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

/**
 * This class stores the Strings used for the Help Window.
 *
 * @author tpruitt
 */
public class Feedback {
    // -- For the Help Section of the Help Window ------------------------------
    public static final int CLOCK                   = 0;
    public static final int LOCATION                = 1;
    public static final int SPEED_LIMIT             = 2;
    public static final int DESCRIPTION             = 3;
    public static final int RESPONDERS              = 4;
    public static final int POLICE                  = 5;
    public static final int IDOT                    = 6;
    public static final int FIRE_FIGHTER            = 7;
    public static final int AMBULANCE               = 8;
    public static final int MESSAGES                = 9;
    public static final int TYPING_MESSAGE          = 10;
    public static final int SEND_MESSAGE            = 11;
    public static final int CREATE_SCENARIO         = 12;
    public static final int MAKE_A_REQUEST          = 13;
    public static final int HELP_WINDOW             = 14;
    public static final int ITEMS                   = 15;
    public static final int PREVIOUS_VEHICLE        = 16;
    public static final int NEXT_VEHICLE            = 17;
    public static final int VEHICLE_ORIENTATION     = 18;
    public static final int WHEEL_ANGLE             = 19;
    public static final int LIGHTS                  = 20;
    public static final int CLEAR_HELP              = 21;
    public static final int RESPONDER_POLICE_DROP   = 22;
    public static final int RESPONDER_POLICE_JOIN   = 23;
    public static final int RESPONDER_FIRE_DROP     = 24;
    public static final int RESPONDER_FIRE_JOIN     = 25;
    public static final int RESPONDER_EMS_DROP      = 26;
    public static final int RESPONDER_EMS_JOIN      = 27;
    public static final int RESPONDER_IDOT_DROP     = 28;
    public static final int RESPONDER_IDOT_JOIN     = 29;

    /**
     * The strings to be displayed in the help-section of the Help Window
     *
     * @author Tim Pruitt
     */
    static final String [] HELP_MESSAGES =
    {
        // clock
        "The Clock is used to display the duration of the current game session."
        + " At the end of the game session, compare your team's duration to the"
        + " suggested duration.",

        // location
        "The Location is displayed to help the"
        + " game feel more like a real-world situation.",

        // speed limit
        "The Speed Limit is displayed to help you decide lengths. Examples "
        + " include the lengths of the safe zone, taper zone and sign distances.",

        // description
        "This displays the vital information about the scenario.",

        // responders
        "The Responder Window displays the departments involved in the scenario"
        + " along with the name of the player associated with that role.",

        // police
        "The Police Officer's name is ",

        // idot
        "The IDOT Responder's name is ",

        // fire fighter
        "The Fire Fighter's name is ",

        // ambulance
        "The E.M.S' name is ",

        // messages
        "The Messages Window acts as a chat room. It is where you are able to"
        + " communicate with all the players in your session.",

        // typing a message
        "This is where you type a message that you want all the players to see."
        + " After you have completed typing your message, click 'Send'.",

        // send a message
        "Click to Send your typed message to all the"
        + " other players in your session.",

        // create a scenario
        "By clicking on this button, you can create new scenario's",

        // make a request
        "By clicking this button, you will be able to make a request to the"
        + " other players. Examples include moving cones and cars and asking"
        + " for additional personel.",

        // help window
        "The 'Help Window' is used to help you understand the program and it's"
        + " components. If you position your mouse over something, details"
        + " about it will be displayed here.",

        // items
        "Items are used in the 'Scene Window'. Some items are draggable into"
        + " the scene while others are just clickable.",

        // previous vehicle
        "Click the 'Previous Button' to control the vehicle that arrived"
        + " before the one you are currently controlling.",

        // next vehicle
        "Click the 'Next Button' to control the vehicle that arrived"
        + " after the one you are currently controlling.",

        // vehicle orientation
        "This panel displays your vehicle's orientation.",

        // wheel angle
        "Use the sideways arrows to change your vehicle's wheel angle.",

        // lights
        "Click on the lighting setup that you want your vehicle to display.",

        // clear
        "",

        // responder police drop
        "Click on this button to stop controlling the Police Department.",

        // responder police join
        "No one is controlling the Police Department. Click on this button to do so.",

        // responder fire drop
        "Click on this button to stop controlling the Fire Department.",

        // responder fire join
        "No one is controlling the Fire Department. Click on this button to do so.",

        // responder EMS drop
        "Click on this button to stop controlling the EMS Responders.",

        // responder EMS join
        "No one is controlling the EMS Responders. Click on this button to do so.",

        // responder IDOT drop
        "Click on this button to stop controlling the Service Patrol Responders.",

        // responder IDOT join
        "No one is controlling the Service Patrol Responders. Click on this button to do so."
    };

    // -- For the Directions Section of the Help Window ------------------------
    public static final int WELCOME                     = 0;
    public static final int CLEAR_DIRECTIONS            = 1;
    public static final int REVIEW_MODE                 = 2;
    public static final int PLAY_MODE                   = 3;
    public static final int EDITOR_MODE                 = 4;
    public static final int RIGHT_CLICK_VEHICLE         = 5;
    public static final int RIGHT_CLICK_REVIEW_MODE     = 6;
    public static final int RIGHT_CLICK_SPECTATOR       = 7;
    public static final int RIGHT_CLICK_ITEM            = 8;
    public static final int CHANGED_CAR_CONDITION       = 9;
    public static final int SENT_MESSAGE                = 10;
    public static final int PREVIOUS_CAR                = 11;
    public static final int NEXT_CAR                    = 12;
    public static final int REMOVED_ROLE                = 13;
    public static final int ADDED_ROLE                  = 14;
    public static final int SCENARIO_LOADED             = 15;
    public static final int ADJUSTED_WHEEL_ANGLE_LEFT   = 16;
    public static final int ADJUSTED_WHEEL_ANGLE_RIGHT  = 17;
    public static final int UPDATED_LIGHTS              = 18;
    public static final int CURRENT_CAR_NULL            = 19;
    public static final int ADDED_ITEMS_TO_CAR          = 20;
    public static final int REMOVED_ITEMS_FROM_CAR      = 21;
    public static final int MAX_ADDED_ITEMS             = 22;
    public static final int ENTER_ADJUSTS_ITEMS         = 23;
    public static final int REQUEST_SENT                = 24;
    public static final int CLICK_SEND_TO_REQUEST       = 25;
    public static final int SCENARIO_SAVED              = 26;
    public static final int COLLISION                   = 27;
    public static final int MOVED_ITEM                  = 28;
    public static final int PLACING_ITEM                = 29;
    public static final int PLACED_ITEM                 = 30;
    public static final int SELECTED_AN_ITEM            = 31;
    public static final int COLLISION_DURING_ROTATION   = 32;
    public static final int ROTATED_CAR                 = 33;



   /**
    * The strings to be displayed in the direction-section of the Help Window.
    *
    * @author Tim Pruitt
    */
    static final String [] DIRECTIONS =
    {
        // welcome
        "Welcome to HIRT: An online training tool for " +
                "Illinois emergency responders.",

        // clear
        "",

        // review mode
        "You are now in review mode. Review the actions " +
                "taken and decide if they are the safest.",

        // play mode
        "You are now in play mode. Select a scenario and manipulate your responder " +
                "vehicles to create a safe work environment.",

        // editor mode
                "You are now in editor mode. Edit the scenario " +
                "and save it so that it can be played.",

        //right click vehicle
                "You right clicked on a vehicle. " +
                "Choose an option that you wish to perform.",

                //right click review mode
                "You right clicked when you are in review mode. There are " +
                "no actions to be performed while in review mode.",

                //right click spectator
                "Since you are not playing any roles, you are considered a spectator. " +
                "If you wish to perform actions, please add a role.",

                //right click item
                "You right clicked on the scene. " +
                "Please select an action to be performed.",

                //changed car condition
                "You have altered the condition of your current vehicle",

                //sent message
                "Your message has been sent.",

                // previous vehicle
                "You have set your current vehicle to the previous one.",

                //next vehicle
                "You have set your current vehicle to the next one.",

                //removed role
                "You have removed a role.",

                //added role
                "You have added a role.",

                // scenario loaded
                "You have loaded a scenario.",

                //adjusted wheel angle left
                "You have adjusted the wheel angle of your current vehicle to the left.",

                // wheel angle right
                "You have adjusted the wheel angle of your current vehicle to the right.",

                //lights
                "You have changed the light setting of your current vehicle.",

                // current car is null
                "You are not controlling a vehicle at this time. " +
                "You are not able to perform actions.",

                //add items
                "You have added additional items to your current vehicle.",

                //remove items
                "You have removed items from your current vehicle.",

                // max items
                "The maximum amount of one particular item a vehicle can " +
                "contain is 32. Please enter an amount within that range.",

                // enter adjusts items
                "You must hit the enter-key to adjust the " +
                "amount of a particular item.",

                //sent request
                "Your request for an additional vehicle has been sent.",

                //click send to request
                "You must click on 'send request' for your request to be sent.",

                //scenario saved
                "Your scenario has been saved.",

                //collision
                "A collision has been detected. Please place the item in a different location.",

                //moved item
                "Your item has been successfully moved.",

                //placing an item
                "You are placing an item. Releasing the mouse to drop the item at that location.",

                // placed item.
                "You have placed the item.",

                //selected an item
                "You have selected an item. Drag it into the scene " +
                "to place it in the desired location.",

                //collision during rotation
                "There was a collision detected during the rotation of your " +
                "current vehicle. Was not able to process the rotation.",

                //rotated car
                "Your current vehicle was rotated successfully."
    };
}
